// Copyright 2024 The langsvr Authors
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its
//    contributors may be used to endorse or promote products derived from
//    this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package protocol

// Enumeration defines an enumeration.
type Enumeration struct {
	// Whether the enumeration is deprecated or not. If deprecated the property contains the deprecation message.
	Deprecated string
	// An optional documentation
	Documentation string
	// The name of the enumeration
	Name string
	// Whether this is a proposed enumeration. If omitted, the enumeration is final.
	Proposed bool
	// Since when (release number) this enumeration is available. Is empty if not known.
	Since string
	// Whether the enumeration supports custom values (e.g. values which are not part of the set defined in values). If omitted no custom values are supported.
	SupportsCustomValues bool
	// The type of the elements
	Type Type
	// The enum values
	Values []*EnumerationEntry
}

func (*Enumeration) isTypeDecl() {}

// EnumerationEntry defines an enumeration entry
type EnumerationEntry struct {
	// Whether the enum entry is deprecated or not. If deprecated the property contains the deprecation message.
	Deprecated string
	// An optional documentation.
	Documentation string
	// The name of the enum item.
	Name string
	// Whether this is a proposed enumeration entry. If omitted, the enumeration entry is final.
	Proposed bool
	// Since when (release number) this enumeration entry is available. Is undefined if not known.
	Since string
	// The value (string or number)
	Value any
}
